<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Welcome to Multi-object trackers in Python’s documentation! &mdash; Multi-object trackers in Python 1.0.0 documentation</title>
      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
        <script src="_static/doctools.js"></script>
        <script src="_static/sphinx_highlight.js"></script>
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Multi-object trackers in Python" href="includeme/readmefile.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
            <a href="#" class="icon icon-home"> Multi-object trackers in Python
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul>
<li class="toctree-l1"><a class="reference internal" href="includeme/readmefile.html">Multi-object trackers in Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/readmefile.html#example-tf-mobilenetssd-centroidtracker">Example: <cite>TF-MobileNetSSD + CentroidTracker</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/readmefile.html#example-yolov3-centroidtracker">Example: <cite>YOLOv3 + CentroidTracker</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html">Tracker</a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#sort">SORT</a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#iou-tracker">IOU Tracker</a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#kalman-filter-based-centroid-tracker">Kalman Filter based Centroid Tracker</a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#tracks">Tracks</a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#kalman-filters">Kalman Filters</a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#object-detection">Object Detection</a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#utilities">Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#references-and-credits">References and Credits</a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#contributor-covenant-code-of-conduct">Contributor Covenant Code of Conduct</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="#">Multi-object trackers in Python</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="#" class="icon icon-home"></a> &raquo;</li>
      <li>Welcome to Multi-object trackers in Python’s documentation!</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="welcome-to-multi-object-trackers-in-python-s-documentation">
<h1>Welcome to Multi-object trackers in Python’s documentation!<a class="headerlink" href="#welcome-to-multi-object-trackers-in-python-s-documentation" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="includeme/readmefile.html">Multi-object trackers in Python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="includeme/readmefile.html#available-multi-object-trackers">Available Multi Object Trackers</a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/readmefile.html#available-opencv-based-object-detectors">Available OpenCV-based object detectors:</a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/readmefile.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/readmefile.html#how-to-use-examples">How to use?: Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/readmefile.html#pretrained-object-detection-models">Pretrained object detection models</a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/readmefile.html#references-credits-and-contributions">References, Credits and Contributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/readmefile.html#citation">Citation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="includeme/readmefile.html#example-tf-mobilenetssd-centroidtracker">Example: <cite>TF-MobileNetSSD + CentroidTracker</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/readmefile.html#example-yolov3-centroidtracker">Example: <cite>YOLOv3 + CentroidTracker</cite></a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html">Tracker</a><ul>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.tracker.Tracker"><code class="docutils literal notranslate"><span class="pre">Tracker</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#sort">SORT</a><ul>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.sort_tracker.assign_tracks2detection_iou"><code class="docutils literal notranslate"><span class="pre">assign_tracks2detection_iou()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.sort_tracker.SORT"><code class="docutils literal notranslate"><span class="pre">SORT</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#iou-tracker">IOU Tracker</a><ul>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.iou_tracker.IOUTracker"><code class="docutils literal notranslate"><span class="pre">IOUTracker</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#kalman-filter-based-centroid-tracker">Kalman Filter based Centroid Tracker</a><ul>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.centroid_kf_tracker.assign_tracks2detection_centroid_distances"><code class="docutils literal notranslate"><span class="pre">assign_tracks2detection_centroid_distances()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.centroid_kf_tracker.CentroidKF_Tracker"><code class="docutils literal notranslate"><span class="pre">CentroidKF_Tracker</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#tracks">Tracks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.track.Track"><code class="docutils literal notranslate"><span class="pre">Track</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.track.KFTrackSORT"><code class="docutils literal notranslate"><span class="pre">KFTrackSORT</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.track.KFTrack4DSORT"><code class="docutils literal notranslate"><span class="pre">KFTrack4DSORT</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.track.KFTrackCentroid"><code class="docutils literal notranslate"><span class="pre">KFTrackCentroid</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#kalman-filters">Kalman Filters</a><ul>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.kalman_tracker.KalmanFilter"><code class="docutils literal notranslate"><span class="pre">KalmanFilter</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.kalman_tracker.KFTrackerConstantAcceleration"><code class="docutils literal notranslate"><span class="pre">KFTrackerConstantAcceleration</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.kalman_tracker.KFTracker1D"><code class="docutils literal notranslate"><span class="pre">KFTracker1D</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.kalman_tracker.KFTracker2D"><code class="docutils literal notranslate"><span class="pre">KFTracker2D</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.kalman_tracker.KFTracker4D"><code class="docutils literal notranslate"><span class="pre">KFTracker4D</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.kalman_tracker.KFTrackerSORT"><code class="docutils literal notranslate"><span class="pre">KFTrackerSORT</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#object-detection">Object Detection</a><ul>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.detectors.detector.Detector"><code class="docutils literal notranslate"><span class="pre">Detector</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.detectors.caffe.Caffe_SSDMobileNet"><code class="docutils literal notranslate"><span class="pre">Caffe_SSDMobileNet</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.detectors.tf.TF_SSDMobileNetV2"><code class="docutils literal notranslate"><span class="pre">TF_SSDMobileNetV2</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.detectors.yolo.YOLOv3"><code class="docutils literal notranslate"><span class="pre">YOLOv3</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#utilities">Utilities</a><ul>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.misc.get_centroid"><code class="docutils literal notranslate"><span class="pre">get_centroid()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.misc.iou"><code class="docutils literal notranslate"><span class="pre">iou()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.misc.iou_xywh"><code class="docutils literal notranslate"><span class="pre">iou_xywh()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.misc.xyxy2xywh"><code class="docutils literal notranslate"><span class="pre">xyxy2xywh()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.misc.xywh2xyxy"><code class="docutils literal notranslate"><span class="pre">xywh2xyxy()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.misc.midwh2xywh"><code class="docutils literal notranslate"><span class="pre">midwh2xywh()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.misc.intersection_complement_indices"><code class="docutils literal notranslate"><span class="pre">intersection_complement_indices()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.misc.nms"><code class="docutils literal notranslate"><span class="pre">nms()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.misc.draw_tracks"><code class="docutils literal notranslate"><span class="pre">draw_tracks()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.misc.load_labelsjson"><code class="docutils literal notranslate"><span class="pre">load_labelsjson()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.misc.dict2jsonfile"><code class="docutils literal notranslate"><span class="pre">dict2jsonfile()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.filechooser_utils.create_filechooser"><code class="docutils literal notranslate"><span class="pre">create_filechooser()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.filechooser_utils.select_caffemodel_prototxt"><code class="docutils literal notranslate"><span class="pre">select_caffemodel_prototxt()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.filechooser_utils.select_caffemodel_weights"><code class="docutils literal notranslate"><span class="pre">select_caffemodel_weights()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.filechooser_utils.select_caffemodel"><code class="docutils literal notranslate"><span class="pre">select_caffemodel()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.filechooser_utils.select_videofile"><code class="docutils literal notranslate"><span class="pre">select_videofile()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.filechooser_utils.select_yolo_weights"><code class="docutils literal notranslate"><span class="pre">select_yolo_weights()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.filechooser_utils.select_coco_labels"><code class="docutils literal notranslate"><span class="pre">select_coco_labels()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.filechooser_utils.select_yolo_config"><code class="docutils literal notranslate"><span class="pre">select_yolo_config()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.filechooser_utils.select_yolo_model"><code class="docutils literal notranslate"><span class="pre">select_yolo_model()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.filechooser_utils.select_pbtxt"><code class="docutils literal notranslate"><span class="pre">select_pbtxt()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.filechooser_utils.select_tfmobilenet_weights"><code class="docutils literal notranslate"><span class="pre">select_tfmobilenet_weights()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#motrackers.utils.filechooser_utils.select_tfmobilenet"><code class="docutils literal notranslate"><span class="pre">select_tfmobilenet()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#download-pretrained-neural-network-weights">Download pretrained neural-network weights.</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#references-and-credits">References and Credits</a></li>
<li class="toctree-l1"><a class="reference internal" href="includeme/apidocuments.html#contributor-covenant-code-of-conduct">Contributor Covenant Code of Conduct</a><ul>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#our-pledge">Our Pledge</a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#our-standards">Our Standards</a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#our-responsibilities">Our Responsibilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#scope">Scope</a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#enforcement">Enforcement</a></li>
<li class="toctree-l2"><a class="reference internal" href="includeme/apidocuments.html#attribution">Attribution</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
</ul>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="includeme/readmefile.html" class="btn btn-neutral float-right" title="Multi-object trackers in Python" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2021, Aditya M. Deshpande.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>